home *** CD-ROM | disk | FTP | other *** search
/ Shareware Super Platinum 8 / Shareware Super Platinum 8.iso / mac / PROGTOOL / SOSENG22.ZIP;1 / SOSENGN.DOC < prev    next >
Encoding:
Text File  |  1993-10-25  |  10.7 KB  |  287 lines
  1. New! Register on Compuserve (GO SWREG  ID# 1461) and get registered version
  2. by E-Mail!
  3.  
  4.  
  5.                         SOS ENGINE INTRODUCTION
  6.  
  7. Have you ever wondered exactly what your application was doing in the
  8. background, what files it was accessing, how many bytes it was reading
  9. or writing, or how other low level functions were being performed?
  10.  
  11. We did.  In fact, the first version of this program was born a couple
  12. of years ago out of desperation when we could not determine why one of our
  13. applications would not print correctly when run on a network.  Since then
  14. we have saved countless hours during the develpment/alpha/beta cycles.
  15.  
  16. We have also used this program to monitor our clients systems and to record
  17. problems for later analysis.  The usefullness of this program is limited
  18. only by your understanding of what it does.
  19.  
  20.  
  21.                                 OVERVIEW
  22.  
  23. The SOS ENGINE consists of two parts.  The first is the 'ENGINE' which
  24. is an 11k memory resident module that can be loaded anywhere in memory.
  25. The engine remains idle in memory until you activate it from your
  26. application.  When activitated, it begins logging selected activities to
  27. a pre-determined file.  Each log entry is time stamped, in 24 hour time,
  28. with a resolution of 1/100th of a second.
  29.  
  30. The second part consists of a standard OBJ file that you link with your
  31. application.  The OBJ file contains 18 functions written entirely in
  32. assembly language, and adds less than 600 bytes to the size of your
  33. finished application.  Each of the eighteen functions are designed to help
  34. you tailor the output of the engine to suit your needs as closely as
  35. possible.
  36.  
  37.  
  38.                               APPLICATION
  39.  
  40. The SOS ENGINE can be used as a debugging tool during the development,
  41. Alpha, and Beta cycles of application development and testing.  If desired,
  42. the code can be left in the application when it is finished as it requires
  43. very little overhead.  The engine could be distributed with the application
  44. and loaded only if needed.  This is a great way to provide an un-paralleled
  45. level of support.
  46.  
  47. It can be extremely usefull for developers of vertical applications.  They
  48. could easily monitor the execution of their software all the time, or at
  49. times when errors are likely to occur.  Log files can easily be printed out
  50. and faxed or mailed to the developer, so he has exact documentation as to
  51. what the application was doing when a problem occurred.
  52.  
  53.  
  54.                            SOS ENGINE REFERENCE
  55.  
  56. The SOS ENGINE consists of two very small modules:
  57.  
  58. SOSENGN.EXE -- This is the memory resident engine portion of the program.
  59. It can be loaded any time you like prior to running an application that
  60. activates it.  It can be loaded into 'HIGH' memory without problem.
  61.  
  62. The engine needs no parameters, and will maintain a log file called SOSENGN
  63. in the directory where the program was first called.  You can unload the
  64. engine from memory by using the /U command line parameter. (i.e. SOSENGN /U)
  65. You may also specify a file name by passing a fully qualified DOS file name
  66. as a command line parameter. (i.e. SOSENGN C:\LOGS\MYLOG.DAT )
  67.  
  68.  
  69.  
  70. SOSFUNC.OBJ -- This is the 'LIBRARY' portion of the program. This file
  71. contains 18 callable functions you may use to control the output of the
  72. engine module.  It has been tested with Clipper, BASIC, Turbo Pascal,
  73. and C, and should work with any dialect of those languages.  It is written
  74. in 100% Assembler, with no language particulars, so it should be pretty much
  75. generic.  Source code is provided.
  76.  
  77.  
  78.                  USING THE FUNCTION LIBRARY WITH BASIC
  79.  
  80. You can use any of the functions in BASIC by linking the OBJ file with
  81. your application, then CALLing the desired function.
  82.  
  83.   Example:  CALL SeOnLog
  84.  
  85. This will activate engine's logging functions. Please look at the file
  86. EXAMPLE.BAS for more information.
  87.  
  88.  
  89.                 USING THE FUNCTION LIBRARY WITH CLIPPER
  90.  
  91. A Clipper application would simply link the OBJ file in the ROOT of their
  92. application ( DO NOT OVERLAY ) and call the desired function as a Clipper
  93. type function.
  94.  
  95.   Example:  SeOnLog()
  96.  
  97. This will activate engine's logging functions as in the BASIC example.
  98. Please look at the file EXAMPLE.PRG for more information.
  99.  
  100.  
  101.                    USING THE FUNCTION LIBRARY WITH C
  102.  
  103. You need only link the OBJ file with your application and call the desired
  104. function.  Please see the file EXAMPLE.C for more information.
  105.  
  106.  
  107.                 USING THE FUNCTION LIBRARY TURBO PASCAL
  108.  
  109. Turbo Pascal requires a little more work.  Please look at the file EXAMPLE.PAS
  110. for a detailed example of how to use the SOS-ENGINE.
  111.  
  112.  
  113.                        FUNCTION LIBRARY REFERENCE
  114.  
  115.  
  116.    SeOnLog      -- Turns on logging functions.
  117.  
  118.    SeOffLog     -- Turns off logging functions.
  119.  
  120.  
  121.  
  122. The following functions can be called whether the engine on or off.  The
  123. default for ALL finctions is ON.
  124.  
  125.  
  126.    SeOnRead      -- Turns on logging of file reads. Records the handle number
  127.                     of the file read, and the number of bytes read.
  128.  
  129.    SeOffRead     -- Turns off logging of file reads.
  130.  
  131.    SeOnWrite     -- Turns on logging of file writes. Records the handle number
  132.                     of the file written to, and the number of bytes written.
  133.  
  134.    SeOffWrite    -- Turns off logging of file writes.
  135.  
  136.    SeOnPntr      -- Turns on logging of file pointer movement. Records the
  137.                     handle number of the file being accessed.
  138.  
  139.    SeOffPntr     -- Turns off logging of file writes.
  140.  
  141.    SeOnMem       -- Turns on logging of memory allocation requests, memory
  142.                     deallocation requests, and memory modfication requests.
  143.  
  144.    SeOffMem      -- Turns off logging of memory functions.
  145.  
  146.    SeOnCl        -- Turns on logging of command line.
  147.  
  148.    SeOffCl       -- Turns off logging of command line.
  149.  
  150.    SeOnFile      -- Turns on logging of file opens, closes, creations,
  151.                     deletions, and renames.
  152.  
  153.    SeOffFile     -- Turns off logging of file activities.
  154.  
  155.    SeOnDir       -- Turns on logging of directory operations such as
  156.                     creations and removals.
  157.  
  158.    SeOffDir      -- Turns off logging of directory activities.
  159.  
  160.    SeOnFa        -- Turns on logging of file attribute activities such as
  161.                     getting and setting of file date ant time settings and
  162.                     getting and setting file attribute bits.
  163.  
  164.    SeOffFa       -- Turns off logging of file attribute activities.
  165.  
  166.  
  167.                           LOG FILE STATEMENTS
  168.  
  169.  
  170.    CmdLin        -- Records whatever was typed at the command line.
  171.  
  172.    Time Changed  -- Records that the user on the application changed the
  173.                     system time.
  174.  
  175.    Create        -- Records the name of a newly created file.
  176.  
  177.    RmDir         -- Records the name of a removed directory.
  178.  
  179.    MkDir         -- Records the name of a created directory.
  180.  
  181.    Open #        -- Records the name and DOS handle of an opened file.
  182.  
  183.    Close #       -- Records the DOS handle on a closed file.
  184.  
  185.    Read #        -- Records the DOS handle and the number of bytes read.
  186.  
  187.    Write #       -- Records the DOS handle and the number of bytes written.
  188.  
  189.    Delete        -- Records the name of the file deleted.
  190.  
  191.    MvPtr #       -- Records the DOS handle of the current file when the
  192.                     file pointer was moved.
  193.  
  194.    GetFA         -- Records file name of a file where the application requested
  195.                     information about its current attribute settings.
  196.  
  197.    SetFA         -- Records file name of a file where the application changed
  198.                     its current attribute settings.
  199.  
  200.    GetFDT        -- Records file name of a file where the application requested
  201.                     information about its date and time stamps.
  202.  
  203.    SetFDT        -- Records file name of a file where the application changed
  204.                     its date and time stamps.
  205.  
  206.    Rename        -- Records the name of a renamed file.
  207.  
  208.    MemAlloc      -- Records that an application requested memory.
  209.  
  210.    RelMem        -- Records that an application released previously allocated
  211.                     memory.
  212.  
  213.    ModMemAlloc   -- Records that an application modified previously allocated
  214.                     memory.
  215.  
  216.  
  217.                       SHAREWARE VERSION INFORMATION
  218.  
  219.  
  220. You may use this program for 30 days as a Shareware product. If you continue
  221. to use the program after that 30 day period, you are required to register.
  222.  
  223. DISK VENDORS and BBS OPERATORS.  You are free to distribute this program
  224. in any form as long as it is unmodified, includes this file and no fee in
  225. excess of $5.00 is charged.
  226.  
  227. The SOS-ENGINE can be purchased in two ways.  The single user version is for
  228. use by one person only.  This is suitable for a developer who wishes to use
  229. the program as a debugging tool on his own computer.
  230.  
  231. If you are a corporate developer, programmer, or consultant or if you want to
  232. be able to distribute the SOS-ENGINE with your applications, then you must
  233. Developer/Run-Time version.  This version allows you to use the SOS-Engine in
  234. a professional environment, and to distrubute the SOS-ENGINE royalty free as
  235. part of your application or software product.
  236.  
  237.  
  238.  
  239.  
  240.  
  241.                         SOS-ENGINE Order Form
  242.  
  243.  
  244. ______ SOS-ENGINE single user version .................. $  25.00  $ ______
  245.               Register on Compuserve... GO SWREG ID# 1461
  246.  
  247. ______ SOS-ENGINE Developer/Run-Time version ........... $  95.00  $ ______
  248.  
  249.  
  250.  
  251. California orders please add Sales Tax .................... 7.75%  $ ______
  252.  
  253.  
  254.                                               Shipping & Handling  $   5.00
  255.  
  256.                                      Overseas Shipping & Handling  $  15.00
  257.  
  258.  
  259.                                                             Total  $ ______
  260.                                              
  261.  
  262.  
  263.                          ORDER LINE: 1-800-388-2761
  264.  
  265.  
  266.   Name / Contact: _____________________________________________________
  267.  
  268.   Company: ____________________________________________________________
  269.  
  270.   Address: ____________________________________________________________
  271.  
  272.          : ____________________________________________________________
  273.  
  274.          : ____________________________________________________________
  275.  
  276.     Phone: ______________________________ FAX: ________________________
  277.  
  278.   MC/VISA: ______________________________ EXP: ________________________
  279.                    (No credit card orders under $50 please)
  280.  
  281.                      Please complete and mail with payment:
  282.  
  283.                               Solid Oak Software
  284.                                  P.O. Box 6826
  285.                            Santa Barbara, CA 93160
  286.                         805-967-9853  FAX 805-967-1614
  287.